Embed Plug-In

This feature is not available in DWS Mode.

The Embed Pug-In feature integrates ToolVad 2.1 functionality into the VoiceConsole interface. This includes:

Embedding the Plug-in into a Task
Optionally embedding any resource files for the Plug-In.

Embedding the plug-in adds the plug-in and (optionally) resource files to a task such as the GWS App. This allows the plug-in to run in embedded mode on the Talkman device. Basic information can be found in the GWS Quick Start Guideand more detailed information is in the documentation for the plug-in. This documentation is delivered with the GWS software bundle

Prerequisites

The Plug-In must be imported into VoiceConsole.
The task must have a Compatible status in the View Tasks table. In most cases this task is GWS App. If a task already has an embedded plug-in, the option to embed another plug-in is disabled.
Optionally, necessary resource files are available in a zip file. For more details see the documentation delivered with your plug-in. Also see:
- GWS Localization Guide: Information on necessary files used to localize the GWS App and Plug-In, available with your GWS software bundle or at help.honeywellaidc.com/Software/GWS_App/Content/Web/GWS_App.htm
- ToolVad User Guide: Background information on the embedding process, including using ToolVad to manually perform this function, available with your GWS software bundle or at help.honeywellaidc.com/Software/GWS_App/Content/Web/GWS_App.htm
Honeywell recommends the following localization files be included for proper fallback if a translated key is not available:
- Locale: This is the locale specific resx file. The resx file name ends with a locale indicator, such as GWExternalResources.es-MX.resx.
- Neutral: This is the first fallback. It specifies the language but there is no locale specified. The resx file ends with just a language identifier such as GEWxExternalResources.es.resx.
- Base: this is the second fall back, in this case it is English. The resx file ends with no identifier such as GWExternalResources.resx.

For some plug-ins the Resources zip file may only contain the resx files used for localization. For other plug-ins there may be additional files. Refer to the documentation delivered with the plug-in for details.

Differences from ToolVad Utility

The functionality varies slightly between the ToolVad utility command functions and VoiceConsole.

ToolVad can embed a plug-in into a task. This feature is available in VoiceConsole.
ToolVad can embed a plug-in and related resource files into a task. This feature is available in VoiceConsole.
ToolVad can embed resources into a task that already contains a plug-in. This feature is not available in VoiceConsole. A new task must be created to embed the plug-in and resources at the same time if using VoiceConsole.
When embedding, VoiceConsole expects separate zip files, one containing the plug-in and the other containing the resource files. ToolVad embeds these items from folders rather than zip files.

Prepare Task

A compatible task must be imported. This task may be the GWS App vad file.

Prepare Plug-In

Locate the files for the plug-in. In most cases this is a folder named Plugin within the plug-in software distribution. The plug-in may be distributed as a zip file. If so, this is the zip file to be used during the embedding process.

Prepare Resources

Folder structure:
1. Create a base folder to contain the resources. In the example below it is a folder called resources.
2. Copy any resx files into this folder. The resx files must be in the root of the folder.
3. Enter any additional files. Honeywell recommends copying these extra files in the same folder structure as delivered with the plug-in. For example:
  Copy
```
resources
|-- Resources
|   |-- prompts.properties
|   |-- prompts_es.properties
|   |-- ...
|-- GWExternalResources.resx
|-- GWExternalResources.es.resx
|-- ...
|-- VoiceAttributes (folder used with VoiceDirect ERP only)
```
4. Zip the contents, so you now have a resources.zip file (if using the naming example above).
5. Refer to the documentation delivered with your plug-in for more information.

In most cases, there is a Resources folder included in the plug-in software distribution. This folder can be zipped and used for the embedding process, however this would embed all languages and increase the task size.

Embed the Plug-In

Select the VoiceConsole tab.
Under Navigation, click Tasks.
From the View Tasks table, select a task that shows Compatible in the Plug-In column.
Under Task Actions, select Embed Plug-In.
On the Embed Plug-In screen select the desired Plug-In and Connector. Some plug-ins have multiple connectors and others may only have one.
Next select the zip file containing the resources as detailed above. This is optional. When using VoiceConsole, resources must be embedded in the task when the plug-in is embedded. Only the ToolVad utility allows resources to be embedded into a task that already has an embedded plug-in.
The task name is populated from a combination of the original task name and the plug-in selected and can be changed but must be unique.
The Task Details are displayed. This screen confirms the languages included in the localization files. Click Finish to accept, specify the sites and then embed the plug-in and any specified resources.
The process completes and displays either a success message or a failure message. A link is provided in the message to view the log file from the embedding process.

The log can only be accessed from this link. Be sure to save the log file if it needs reviewed before dismissing the notification.
VoiceConsole returns to the View Tasks page where you can verify the task now shows embedded in the Plug-In column of the table.

Troubleshooting

If an error occurs during the embedding process, the completion message displays a link to the log. The link to download the log is displayed regardless of embedding success or failure.

Review the log for information if the process failed.

Compatibility

VoiceConsole 6.5.1 contains ToolVad 2.1. The following components were tested with this release:

GWS App 3.4.1
GWS Distribution Plug-In 2.0
GWS Picking Plug-In 1.5, 1.3.2 (GWS Picking Plug-In was renamed to GWS Distribution Plug-In)
GWS Distribution Demo 2.0
GWS Picking Demo 1.3, 1.2.2, 1.1 (GWS Picking Demo was renamed to GWS Distribution Demo)
GWS Checklist Plug-In 2.1, 2.0.1, 1.4
GWS Scraping Demo 1.4, 1.3
GWS VoiceDirect ERP Plug-In for use with SAP 3.5.1, 3.5, 3.4.1, 3.3
GWS VoiceLink Plug-In 1.3, 1.2, 1.1, 1.06

It is possible other combinations may work that were not tested, however it is the user's responsibility to confirm the success of the embedding process.